[UII] Expose advanced file logging config in UI #200274

jen-huang · 2024-11-14T23:06:09Z

Summary

Resolves #192237. This PR exposes the following Elastic Agent file logging configuration options in the agent policy advanced settings UI:

agent.logging.to_files
agent.logging.files.rotateeverybytes 
agent.logging.files.keepfiles
agent.logging.files.interval

This PR also does some clean up on the default values for all these configured advanced settings so that when user has not touched them, the default values do not get written into the agent policy saved object. More info here.

It also fixes adds missing response schemas for the advanced settings.

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

elasticmachine · 2024-11-14T23:06:12Z

Pinging @elastic/fleet (Team:Fleet)

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'

criamico · 2024-11-18T11:20:20Z

x-pack/plugins/fleet/server/services/form_settings/form_settings.ts

@@ -24,40 +24,19 @@ export function _getSettingsAPISchema(settings: SettingsConfig[]): Props {
    if (!setting.api_field) {
      return;
    }
-    const defaultValueRes = setting.schema.safeParse(undefined);
-    const defaultValue = defaultValueRes.success ? defaultValueRes.data : undefined;
-    if (defaultValue) {


Just a question: it's ok to remove the default value but it's not clear to me why . Is that a change in requirement or was it causing some issues?

@criamico I found that when the default value is present in the API schema, it means that they will get added regardless of what the original request payload is

for example, for this request that updates a single advanced option:

PUT kbn:/api/fleet/agent_policies/<policy id> { "advanced_settings": { "agent_logging_to_files": false } }

once it makes it way to the handler, any advanced options with a default value gets added to the update policy payload:

{ "advanced_settings": { "agent_logging_level": "info", "agent_logging_to_files": false } }

this means that advanced options that the user did not touch at all gets saved into the agent policy. I don't think this is correct behavior because we prefer to let elastic agent fill in default values rather than dictating it from Fleet. imagine that elastic agent changes the default value of this config to something better in the future, in this case agents enrolled in this policy will not get the updated default value because it got hardcoded into the agent policy due to this behavior.

hope this helps!

jillguyonnet · 2024-11-18T11:40:12Z

Tested and looks good. I was able to set negative values through the UI (not the API) though (it saved successfully), is this something that can be fixed?

… into feat/adv-logging-config

…nfig

jen-huang · 2024-11-19T22:39:07Z

Tested and looks good. I was able to set negative values through the UI (not the API) though (it saved successfully), is this something that can be fixed?

@jillguyonnet Fixed!

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'

elasticmachine · 2024-11-20T02:33:08Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 1b1eb77

Failed CI Steps

Jest Tests #13

Test Failures

[job] [logs] Jest Tests #13 / UserActionsList renders list correctly with isExpandable option

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`fleet`	1.7MB	1.7MB	+2.9KB

History

cc @jen-huang

criamico

LGTM 🚀

jillguyonnet

LGTM, thanks for the fix 🚀

kibanamachine · 2024-11-20T17:42:09Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11938833595

kibanamachine · 2024-11-20T17:47:11Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 200274

Questions ?

Please refer to the Backport tool documentation

jen-huang · 2024-11-20T18:37:06Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

## Summary Resolves [elastic#192237](elastic#192237). This PR exposes the following Elastic Agent file logging configuration options in the agent policy advanced settings UI: ``` agent.logging.to_files agent.logging.files.rotateeverybytes agent.logging.files.keepfiles agent.logging.files.interval ``` <img width="1237" alt="image" src="https://github.com/user-attachments/assets/8de9023c-29a0-4ecf-803a-d8c0c4b87616"> This PR also does some clean up on the default values for all these configured advanced settings so that when user has not touched them, the default values do not get written into the agent policy saved object. [More info here](elastic#200274 (comment)). It also fixes adds missing response schemas for the advanced settings. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit 0aa63a7) # Conflicts: # oas_docs/bundle.json # oas_docs/bundle.serverless.json # oas_docs/output/kibana.serverless.yaml # oas_docs/output/kibana.yaml # x-pack/plugins/fleet/server/routes/agent_policy/index.test.ts # x-pack/plugins/fleet/server/services/form_settings/form_settings.ts # x-pack/plugins/fleet/server/types/models/agent_policy.ts

) # Backport This will backport the following commits from `main` to `8.x`: - [[UII] Expose advanced file logging config in UI (#200274)](#200274)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

## Summary Resolves [elastic#192237](elastic#192237). This PR exposes the following Elastic Agent file logging configuration options in the agent policy advanced settings UI: ``` agent.logging.to_files agent.logging.files.rotateeverybytes agent.logging.files.keepfiles agent.logging.files.interval ``` <img width="1237" alt="image" src="https://github.com/user-attachments/assets/8de9023c-29a0-4ecf-803a-d8c0c4b87616"> This PR also does some clean up on the default values for all these configured advanced settings so that when user has not touched them, the default values do not get written into the agent policy saved object. [More info here](elastic#200274 (comment)). It also fixes adds missing response schemas for the advanced settings. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <[email protected]>

jen-huang added 3 commits November 14, 2024 14:07

Add new logging config options

b692e19

Don't add default value to advanced settings REST schema

699bb68

Add file interval setting

201484f

jen-huang added Team:Fleet Team label for Observability Data Collection Fleet team release_note:feature Makes this part of the condensed release notes backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Nov 14, 2024

jen-huang self-assigned this Nov 14, 2024

jen-huang requested a review from a team as a code owner November 14, 2024 23:06

kibanamachine added 2 commits November 14, 2024 23:21

[CI] Auto-commit changed files from 'make api-docs'

c1b09ed

criamico reviewed Nov 18, 2024

View reviewed changes

jen-huang added 4 commits November 19, 2024 11:10

Merge branch 'feat/adv-logging-config' of github.com:jen-huang/kibana…

9499cc0

… into feat/adv-logging-config

Merge remote-tracking branch 'upstream/main' into feat/adv-logging-co…

0dc477f

…nfig

Set minimum and add unit tests

33a6816

Fix i18n

5ca5205

jen-huang requested review from criamico and jillguyonnet November 19, 2024 22:39

kibanamachine and others added 3 commits November 19, 2024 22:55

Merge branch 'main' into feat/adv-logging-config

4a832b7

[CI] Auto-commit changed files from 'make api-docs'

1b1eb77

criamico approved these changes Nov 20, 2024

View reviewed changes

jillguyonnet approved these changes Nov 20, 2024

View reviewed changes

jen-huang merged commit 0aa63a7 into elastic:main Nov 20, 2024
24 checks passed

jen-huang deleted the feat/adv-logging-config branch November 20, 2024 17:41

kibanamachine added the v9.0.0 label Nov 20, 2024

jen-huang mentioned this pull request Nov 20, 2024

[8.x] [UII] Expose advanced file logging config in UI (#200274) #201021

Merged

kibanamachine added the v8.17.0 label Nov 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[UII] Expose advanced file logging config in UI #200274

[UII] Expose advanced file logging config in UI #200274

jen-huang commented Nov 14, 2024 •

edited by kibanamachine

Loading

elasticmachine commented Nov 14, 2024

criamico Nov 18, 2024

jen-huang Nov 19, 2024 •

edited

Loading

jillguyonnet commented Nov 18, 2024 •

edited

Loading

jen-huang commented Nov 19, 2024

elasticmachine commented Nov 20, 2024

criamico left a comment

jillguyonnet left a comment

kibanamachine commented Nov 20, 2024

kibanamachine commented Nov 20, 2024

jen-huang commented Nov 20, 2024

[UII] Expose advanced file logging config in UI #200274

[UII] Expose advanced file logging config in UI #200274

Conversation

jen-huang commented Nov 14, 2024 • edited by kibanamachine Loading

Summary

Checklist

elasticmachine commented Nov 14, 2024

criamico Nov 18, 2024

Choose a reason for hiding this comment

jen-huang Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

jillguyonnet commented Nov 18, 2024 • edited Loading

jen-huang commented Nov 19, 2024

elasticmachine commented Nov 20, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Async chunks

History

criamico left a comment

Choose a reason for hiding this comment

jillguyonnet left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 20, 2024

kibanamachine commented Nov 20, 2024

💔 All backports failed

Manual backport

Questions ?

jen-huang commented Nov 20, 2024

💚 All backports created successfully

Questions ?

jen-huang commented Nov 14, 2024 •

edited by kibanamachine

Loading

jen-huang Nov 19, 2024 •

edited

Loading

jillguyonnet commented Nov 18, 2024 •

edited

Loading